bitkeeper revision 1.1159.202.1 (41abc3b28rm0fezCkoFB5SbFQ3QnFw)
authoriap10@labyrinth.cl.cam.ac.uk <iap10@labyrinth.cl.cam.ac.uk>
Tue, 30 Nov 2004 00:49:54 +0000 (00:49 +0000)
committeriap10@labyrinth.cl.cam.ac.uk <iap10@labyrinth.cl.cam.ac.uk>
Tue, 30 Nov 2004 00:49:54 +0000 (00:49 +0000)
Add kerneldoc comments to teardow_irq

linux-2.6.10-rc2-xen-sparse/kernel/irq/manage.c

index 0c69a286698c8da52e2037bfa977dbfed2bc854b..fb7f365b3d8a6762740502e359e83c188ffa87b8 100644 (file)
@@ -144,9 +144,14 @@ int can_request_irq(unsigned int irq, unsigned long irqflags)
        return !action;
 }
 
-/*
- * Internal function to register an irqaction - typically used to
- * allocate special interrupts that are part of the architecture.
+/**
+ *     setup_irq - register an irqaction structure
+ *     @irq: Interrupt to register
+ *     @irqaction: The irqaction structure to be registered
+ *
+ *     Normally called by request_irq, this function can be used
+ *     directly to allocate special interrupts that are part of the
+ *     architecture.
  */
 int setup_irq(unsigned int irq, struct irqaction * new)
 {
@@ -216,8 +221,17 @@ int setup_irq(unsigned int irq, struct irqaction * new)
 }
 
 /*
- * Internal function to unregister an irqaction - typically used to
- * deallocate special interrupts that are part of the architecture.
+ *     teardown_irq - unregister an irqaction
+ *     @irq: Interrupt line being freed
+ *     @old: Pointer to the irqaction that is to be unregistered
+ *
+ *     This function is called by free_irq and does the actual
+ *     business of unregistering the handler. It exists as a 
+ *     seperate function to enable handlers to be unregistered 
+ *     for irqactions that have been allocated statically at 
+ *     boot time.
+ *
+ *     This function must not be called from interrupt context.
  */
 int teardown_irq(unsigned int irq, struct irqaction * old)
 {